
<!DOCTYPE html>
<!--

    Copyright (c) 2017, 2019 Oracle and/or its affiliates. All rights reserved.

    This program and the accompanying materials are made available under the
    terms of the Eclipse Public License v. 2.0, which is available at
    http://www.eclipse.org/legal/epl-2.0.

    This Source Code may also be made available under the following Secondary
    Licenses when the conditions for such availability set forth in the
    Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
    version 2 with the GNU Classpath Exception, which is available at
    https://www.gnu.org/software/classpath/license.html.

    SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0

-->
<!-- Portions Copyright [2019] [Payara Foundation and/or its affiliates] -->
<html lang="en">
  <head>
    <meta charset="utf-8"/>
    <title>create-resource-ref</title>
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <link href="css/style.css" rel="stylesheet">
    <script src="https://use.fontawesome.com/96c4d89611.js"></script>
  </head>
  <body>
<table id="doc-title" cellspacing="0" cellpadding="0">
  <tr>
  <td align="left" valign="top">
  <b>create-resource-ref</b><br />
  </td>
  </tr>
</table>
<hr />

<table width="90%" id="top-nav" cellspacing="0" cellpadding="0">
	<colgroup>
		<col width="12%"/>
		<col width="12%"/>
		<col width="*"/>
	</colgroup>
	<tr>
		<td align="left">
		<a href="create-resource-adapter-config.html">
			<span class="vector-font"><i class="fa fa-arrow-circle-left" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Previous</span>
		</a>
		</td>

		<td align="left">
		<a href="create-service.html">
			<span class=" vector-font"><i class="fa fa-arrow-circle-right vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Next</span>
		</a>
		</td>

		<td align="right">
		<a href="toc.html">
			<span class=" vector-font"><i class="fa fa-list vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Contents</span>
		</a>
		</td>
	</tr>
</table>


<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p><a id="create-resource-ref-1"></a><a id="GSRFM00055"></a><a id="create-resource-ref"></a></p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_create_resource_ref">create-resource-ref</h2>
<div class="sectionbody">
<div class="paragraph">
<p>creates a reference to a resource</p>
</div>
<div id="sthref519" class="paragraph">
<p>Synopsis</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code class="language-oac_no_warn" data-lang="oac_no_warn">asadmin [asadmin-options] create-resource-ref [--help]
[--target target]
[--enabled={false|true}] reference_name</code></pre>
</div>
</div>
<div id="sthref520" class="paragraph">
<p>Description</p>
</div>
<div class="paragraph">
<p>The <code>create-resource-ref</code> subcommand creates a reference from a cluster
or an unclustered server instance to a previously created resource, for
example, a JDBC resource created by using the <code>create-jdbc-resource</code>
subcommand. This effectively results in the resource being made
available in the JNDI tree of the instance or cluster.</p>
</div>
<div class="paragraph">
<p>The target instance or instances making up the cluster need not be
running or available for this subcommand to succeed. If one or more
instances are not available, they will receive the new resource the next
time they start.</p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">
<div class="paragraph">
<p>A <code>resource-ref</code> can only be created for bindable resources, such as a
<code>jdbc-resource</code>, <code>connector-resource</code>, <code>admin-object-resource</code>,
<code>mail-resource</code>, <code>custom-resource</code>, or <code>jndi-resource</code>.</p>
</div>
<div class="paragraph">
<p>A <code>jdbc-connection-pool</code> or a <code>connector-connection-pool</code> are not
referred to directly by applications. Instead, they are referred to
through a <code>jdbc-resource</code> or <code>connector-resource</code>, respectively.</p>
</div>
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>This subcommand is supported in remote mode only.</p>
</div>
<div id="sthref521" class="paragraph">
<p>Options</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">asadmin-options</dt>
<dd>
<p>Options for the <code>asadmin</code> utility. For information about these
options, see the <a href="asadmin.html#asadmin-1m"><code>asadmin</code>(1M)</a> help page.</p>
</dd>
<dt class="hdlist1"><code>--help</code></dt>
<dt class="hdlist1"><code>-?</code></dt>
<dd>
<p>Displays the help text for the subcommand.</p>
</dd>
<dt class="hdlist1"><code>--target</code></dt>
<dd>
<p>Specifies the target for which you are creating the resource
reference. Valid targets are as follows:<br></p>
<div class="dlist">
<dl>
<dt class="hdlist1"><code>server</code></dt>
<dd>
<p>Creates the resource reference for the default server instance. This
is the default target.</p>
</dd>
<dt class="hdlist1">cluster_name</dt>
<dd>
<p>Creates the resource reference for every server instance in the
cluster.</p>
</dd>
<dt class="hdlist1">instance_name</dt>
<dd>
<p>Creates the resource reference for the named unclustered server
instance.</p>
</dd>
</dl>
</div>
</dd>
<dt class="hdlist1"><code>--enabled</code></dt>
<dd>
<p>Indicates whether the resource should be enabled. This value will take
effect only if the resource is enabled at the global level. The
default is <code>true</code>.</p>
</dd>
</dl>
</div>
<div id="sthref522" class="paragraph">
<p>Operands</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">reference_name</dt>
<dd>
<p>The name or JNDI name of the resource.</p>
</dd>
</dl>
</div>
<div id="sthref523" class="paragraph">
<p>Examples</p>
</div>
<div class="paragraph">
<p><a id="GSRFM520"></a><a id="sthref524"></a></p>
</div>
<div class="paragraph">
<p>Example 1   Creating a Reference to a JMS Destination Resource</p>
</div>
<div class="paragraph">
<p>This example creates a reference to the JMS destination resource
<code>jms/Topic</code> on the cluster <code>Cluster1</code>.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code class="language-oac_no_warn" data-lang="oac_no_warn">asadmin&gt; create-resource-ref --target Cluster1 jms/Topic
resource-ref jms/Topic created successfully.
Command create-resource-ref executed successfully.</code></pre>
</div>
</div>
<div id="sthref525" class="paragraph">
<p>Exit Status</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">0</dt>
<dd>
<p>subcommand executed successfully</p>
</dd>
<dt class="hdlist1">1</dt>
<dd>
<p>error in executing the subcommand</p>
</dd>
</dl>
</div>
<div id="sthref526" class="paragraph">
<p>See Also</p>
</div>
<div class="paragraph">
<p><a href="asadmin.html#asadmin-1m"><code>asadmin</code>(1M)</a></p>
</div>
<div class="paragraph">
<p><a href="delete-resource-ref.html#delete-resource-ref-1"><code>delete-resource-ref</code>(1)</a>,
<a href="list-resource-refs.html#list-resource-refs-1"><code>list-resource-refs</code>(1)</a></p>
</div>
</div>
</div>

<hr />

<table width="90%" id="bottom-nav" cellspacing="0" cellpadding="0">
	<colgroup>
		<col width="12%"/>
		<col width="12%"/>
		<col width="*"/>
	</colgroup>
	<tr>		
		<td align="left">
		<a href="create-resource-adapter-config.html">
			<span class=" vector-font"><i class="fa fa-arrow-circle-left" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Previous</span>
		</a>
		</td>

		<td align="left">
		<a href="create-service.html">
			<span class="vector-font"><i class="fa fa-arrow-circle-right vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Next</span>
		</a>
		</td>

		<td align="right">
		<a href="toc.html">
			<span class="vector-font"><i class="fa fa-list vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Contents</span>
		</a>
		</td>
	</tr>
</table>

<span id="copyright">
        <img src="/resource/reference/img/eclipse_foundation_logo_tiny.png" height="20px" alt="Eclipse Foundation Logo" align="top"/>&nbsp;            
        <span >Copyright&nbsp;&copy;&nbsp;2019,&nbsp;Oracle&nbsp;and/or&nbsp;its&nbsp;affiliates.&nbsp;All&nbsp;rights&nbsp;reserved.</span>
</span>

</body>
</html>
